Skip to main content

Retrieve a ticket

Request

This method retrieves a ticket by its ID for a user with permission to view this request.

Security
BearerAuth
Path
idstring, [ 1 .. 100 ]required

Identifier of the ticket.

Payload
// No request payload

Responses

Ok

Bodyapplication/json
categorystring, [ 10 .. 100 ] characters

Tickets Category.

Example:"Network"
subCategorystring, [ 10 .. 100 ] characters

Tickets Sub Category.

Example:"NE Connectivity Issue"
descriptionstring, [ 10 .. 4000 ] characters

Description of the trouble or issue.

Example:"Trouble Descriptions of network connections"
primaryIdstring, [ 10 .. 100 ] characters

Primary reference identifier associated with the troubled asset, such as cage identifier.

Example:"AM0:000:00000"
occurredDateTimestring, (date-time)

Date and time the issue occurred.

idstring, [ 10 .. 20 ] characters

Unique identifier of the ticket.

Example:"1-9808089098"
secondaryIdstring, [ 10 .. 100 ] characters

Secondary reference identifier associated with the troubled asset.

Example:"AM0:000:00000:000"
customerReferenceIdstring, [ 10 .. 100 ] characters

Customer Reference Number / External Reference Number.

Example:"External Reference Number"
resolutionDateTimestring, (date-time)

The resolution date and time

resolutionsArray of objects(Resolutions)

Resolution Details.

statusstring

The current status of the ticket.

Enum:"RECEIVED""IN_PROGRESS""ON_HOLD""CLOSED""CANCELLED"
detailsLAYER1_0000_XXXX (object) or NETWORK_0001_XXXX (object) or POWER_0002_XXXX (object) or ENVIRONMENT_0003_XXXX (object) or HARDWARE_0004_XXXX (object) or SECURITY_0005_XXXX (object) or MANAGED_SERVICE_0006_XXXX (object) or SMARTVIEW_0007_XXXX (object) or SMARTKEY_0008XXXX (object) or BILLING_0010XXXX (object) or METROCONNECT_0012_XXXX (object)
Any of:

Details or requirements to support ticket resolution, depending on the trouble category you are facing.

notesArray of objects(Note)

The note(s) that are associated to the ticket.

attachmentsArray of objects, <= 5 items(Attachment)

File(s) attached to the ticket

contactsArray of objects(Contacts)

List of persons who will be contacted for this ticket.

Response
[ { "category": "Network", "subCategory": "General Network connectivity Issue", "description": "None", "primaryId": "SG0:00:000000", "occurredDateTime": "2020-12-12T18:17:04.000Z", "id": "1-20001234567", "resolutionDateTime": "2020-12-12T18:19:44Z", "resolutions": [ … ], "status": "CLOSED", "contacts": [ … ], "notes": [ … ], "details": { … } } ]
Was this page helpful?